home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cheevd.z / cheevd
Encoding:
Text File  |  2002-10-03  |  6.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHEEEEEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHEEEEEEEEVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHEEVD - compute all eigenvalues and, optionally, eigenvectors of a
  10.      complex Hermitian matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CHEEVD( JOBZ, UPLO, N, A, LDA, W, WORK, LWORK, RWORK, LRWORK,
  14.                         IWORK, LIWORK, INFO )
  15.  
  16.          CHARACTER      JOBZ, UPLO
  17.  
  18.          INTEGER        INFO, LDA, LIWORK, LRWORK, LWORK, N
  19.  
  20.          INTEGER        IWORK( * )
  21.  
  22.          REAL           RWORK( * ), W( * )
  23.  
  24.          COMPLEX        A( LDA, * ), WORK( * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      CHEEVD computes all eigenvalues and, optionally, eigenvectors of a
  41.      complex Hermitian matrix A. If eigenvectors are desired, it uses a divide
  42.      and conquer algorithm.
  43.  
  44.      The divide and conquer algorithm makes very mild assumptions about
  45.      floating point arithmetic. It will work on machines with a guard digit in
  46.      add/subtract, or on those binary machines without guard digits which
  47.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  48.      conceivably fail on hexadecimal or decimal machines without guard digits,
  49.      but we know of none.
  50.  
  51.  
  52. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  53.      JOBZ    (input) CHARACTER*1
  54.              = 'N':  Compute eigenvalues only;
  55.              = 'V':  Compute eigenvalues and eigenvectors.
  56.  
  57.      UPLO    (input) CHARACTER*1
  58.              = 'U':  Upper triangle of A is stored;
  59.              = 'L':  Lower triangle of A is stored.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHEEEEEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHEEEEEEEEVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      A       (input/output) COMPLEX array, dimension (LDA, N)
  78.              On entry, the Hermitian matrix A.  If UPLO = 'U', the leading N-
  79.              by-N upper triangular part of A contains the upper triangular
  80.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  81.              triangular part of A contains the lower triangular part of the
  82.              matrix A.  On exit, if JOBZ = 'V', then if INFO = 0, A contains
  83.              the orthonormal eigenvectors of the matrix A.  If JOBZ = 'N',
  84.              then on exit the lower triangle (if UPLO='L') or the upper
  85.              triangle (if UPLO='U') of A, including the diagonal, is
  86.              destroyed.
  87.  
  88.      LDA     (input) INTEGER
  89.              The leading dimension of the array A.  LDA >= max(1,N).
  90.  
  91.      W       (output) REAL array, dimension (N)
  92.              If INFO = 0, the eigenvalues in ascending order.
  93.  
  94.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  95.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  96.  
  97.      LWORK   (input) INTEGER
  98.              The length of the array WORK.  If N <= 1,                LWORK
  99.              must be at least 1.  If JOBZ  = 'N' and N > 1, LWORK must be at
  100.              least N + 1.  If JOBZ  = 'V' and N > 1, LWORK must be at least
  101.              2*N + N**2.
  102.  
  103.              If LWORK = -1, then a workspace query is assumed; the routine
  104.              only calculates the optimal size of the WORK array, returns this
  105.              value as the first entry of the WORK array, and no error message
  106.              related to LWORK is issued by XERBLA.
  107.  
  108.      RWORK   (workspace/output) REAL array,
  109.              dimension (LRWORK) On exit, if INFO = 0, RWORK(1) returns the
  110.              optimal LRWORK.
  111.  
  112.      LRWORK  (input) INTEGER
  113.              The dimension of the array RWORK.  If N <= 1,
  114.              LRWORK must be at least 1.  If JOBZ  = 'N' and N > 1, LRWORK must
  115.              be at least N.  If JOBZ  = 'V' and N > 1, LRWORK must be at least
  116.              1 + 5*N + 2*N**2.
  117.  
  118.              If LRWORK = -1, then a workspace query is assumed; the routine
  119.              only calculates the optimal size of the RWORK array, returns this
  120.              value as the first entry of the RWORK array, and no error message
  121.              related to LRWORK is issued by XERBLA.
  122.  
  123.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  124.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHEEEEEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHEEEEEEEEVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LIWORK  (input) INTEGER
  141.              The dimension of the array IWORK.  If N <= 1,
  142.              LIWORK must be at least 1.  If JOBZ  = 'N' and N > 1, LIWORK must
  143.              be at least 1.  If JOBZ  = 'V' and N > 1, LIWORK must be at least
  144.              3 + 5*N.
  145.  
  146.              If LIWORK = -1, then a workspace query is assumed; the routine
  147.              only calculates the optimal size of the IWORK array, returns this
  148.              value as the first entry of the IWORK array, and no error message
  149.              related to LIWORK is issued by XERBLA.
  150.  
  151.      INFO    (output) INTEGER
  152.              = 0:  successful exit
  153.              < 0:  if INFO = -i, the i-th argument had an illegal value
  154.              > 0:  if INFO = i, the algorithm failed to converge; i off-
  155.              diagonal elements of an intermediate tridiagonal form did not
  156.              converge to zero.
  157.  
  158. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  159.      Based on contributions by
  160.         Jeff Rutter, Computer Science Division, University of California
  161.         at Berkeley, USA
  162.  
  163.  
  164. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  165.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  166.  
  167.      This man page is available only online.
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.